<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<style type="text/css">

body {
  font-family: sans-serif;
  background-color: #FFF;
  color:#000;
}

img {
  border: 0;
}

ul.menu { 
   position:relative;
   margin-bottom:0px;
   margin-top:0px;
   left:-2.5em;
}

a { text-decoration: none; }

a:hover { font-weight: bold; }

li.menu { 
   list-style-type: none;
   position: relative;
   text-decoration: none;
}


#sidebar { 
   position: absolute;
   left:0px;
   padding:2em;
   top:0em;
   width:13em;
}

#content { 
  position: absolute;
  left:13em; top:0em;
  padding-left:3em;
  padding-right:3em;
  padding-bottom:1em;
  margin-top:1em;
  margin-right:2em;
}

div.mbox {
  background-color:#EEEEFF;
  border: 1px solid #bbbbff;
  padding: 0.5em 0.5em 0.5em 0.5em;
  margin:1em;
  width: 10em;
  -moz-border-radius-topleft: 9px;	
  -moz-border-radius-topright: 9px;
  -moz-border-radius-bottomleft: 9px;	
  -moz-border-radius-bottomright: 9px;
}

div.title { 
  font-weight:bold; 
  background-color:#DDDDFF; 
  margin-bottom:1px;
}

</style>
<title>ucanvcam: ParamEffect Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<LINK REL="SHORTCUT ICON" HREF="favicon.ico">
</head><body>

<div id="sidebar"> 

<h2 style="text-align:center;">ucanvcam</h2>



<div class="mbox">
<div class=title>The Manual</div>
<ul class=menu>
<li class=menu><a href="index.html">Main&nbsp;Page</a></li>
<li class=menu><a href="annotated.html">Classes</a></li>
<li class=menu><a href="install.html">Installation</a></li>
<li class=menu><a href="linux_tips.html">Linux Tips</a></li>
<li class=menu><a href="windows_tips.html">Windows Tips</a></li>
</ul>
</div>

<div class="mbox">
<div class=title>Online Resources</div>
<ul class=menu>
<li class=menu><a href="http://code.google.com/p/ucanvcam/">Project page</a></li>
<li class=menu><a href="http://code.google.com/p/ucanvcam/downloads/list">Downloads</a></li>
<li class=menu><a href="http://code.google.com/p/ucanvcam/w/list">Wiki</a></li>
<li class=menu><a href="http://code.google.com/p/ucanvcam/source/checkout">Repository</a></li>
</ul>
</div>


<div class="mbox">
<div class=title>Related&nbsp;Links</div>
<ul class=menu>
<li class=menu><a href="http://eris.liralab.it/yarp">YARP</a></li>
<li class=menu><a href="http://www.makesweet.com/">MakeSweet</a></li>
<li class=menu><a href="http://effectv.sourceforge.net/">EffecTV</a></li>
<li class=menu><a href="http://www.allocinit.com/index.php?title=CamTwist">CamTwist</a></li>
</ul>



</div>

<center>
<i><small>generated by doxygen</small></i>
</center>


</div>


<div id="content" >

<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
</div>
<div class="contents">
<h1>ParamEffect Class Reference</h1><!-- doxytag: class="ParamEffect" --><!-- doxytag: inherits="Effect" -->A meta-effect that allows the current effect to be select remotely.  
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for ParamEffect:</div>
<div class="dynsection">

<p><center><img src="classParamEffect.png" usemap="#ParamEffect_map" border="0" alt=""></center>
<map name="ParamEffect_map">
<area href="classEffect.html" alt="Effect" shape="rect" coords="0,0,81,24">
</map>
</div>

<p>
<a href="classParamEffect-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="99476c396d079ea4e6177f8677aa8146"></a><!-- doxytag: member="ParamEffect::apply" ref="99476c396d079ea4e6177f8677aa8146" args="(Bottle &amp;in, Bottle &amp;out)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>apply</b> (Bottle &amp;in, Bottle &amp;out)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4dea2a63a39edc855479f6a8a64f0c9c"></a><!-- doxytag: member="ParamEffect::read" ref="4dea2a63a39edc855479f6a8a64f0c9c" args="(yarp::os::ConnectionReader &amp;connection)" -->
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>read</b> (yarp::os::ConnectionReader &amp;connection)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="2b4b7f190c6bbd2a9ab86e48a40b3357"></a><!-- doxytag: member="ParamEffect::start" ref="2b4b7f190c6bbd2a9ab86e48a40b3357" args="()" -->
virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParamEffect.html#2b4b7f190c6bbd2a9ab86e48a40b3357">start</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prepare the effect for operation. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParamEffect.html#0ab9e6d39aa2f5648a5a099b7a5ca26f">stop</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Prepare the effect to cease operation.  <a href="#0ab9e6d39aa2f5648a5a099b7a5ca26f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="57d3edb8215f0ec5e1d13c8db8ba341d"></a><!-- doxytag: member="ParamEffect::pdraw" ref="57d3edb8215f0ec5e1d13c8db8ba341d" args="(yarp::sig::Image &amp;src, yarp::sig::Image &amp;dest)" -->
virtual yarp::sig::Image *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParamEffect.html#57d3edb8215f0ec5e1d13c8db8ba341d">pdraw</a> (yarp::sig::Image &amp;src, yarp::sig::Image &amp;dest)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Modify an image in any format in an effect-specific way, producing an output in any format. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="08cb3b7dc7c2265ccff778289fb0c664"></a><!-- doxytag: member="ParamEffect::getName" ref="08cb3b7dc7c2265ccff778289fb0c664" args="()" -->
std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classParamEffect.html#08cb3b7dc7c2265ccff778289fb0c664">getName</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the name of an effect. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A meta-effect that allows the current effect to be select remotely. 
<p>
Communication is via a YARP port. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="0ab9e6d39aa2f5648a5a099b7a5ca26f"></a><!-- doxytag: member="ParamEffect::stop" ref="0ab9e6d39aa2f5648a5a099b7a5ca26f" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool ParamEffect::stop           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Prepare the effect to cease operation. 
<p>
It may be started again without a close/open cycle. 
<p>Reimplemented from <a class="el" href="classEffect.html#22e1a125086c38f05b13df3411f8edfb">Effect</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>src/native_effects/ParamEffect.cpp</ul>
</div>

</div>

</body>
</html>
